docs: add architecture explanation page #1012
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There are discussions about using "Ubuntu on WSL". These discussions are not mature, however, and we should not use the new terminology without achieving consensus.
edibotopic
force-pushed
the
ref-arch-explanation
branch
from
7266d44 to
f15aef4
Compare
|
Thanks for the review and your insightful comments @CarlosNihelton . I reverted to "Ubuntu WSL" in 77b116a, applied your suggestions to the explanation in 19e1447 and the ones for the reference in f15aef4. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In d03d56e a dedicated explanation section that includes a page describing the architecture of UP4W and its components.
Previously, UP4W components and other topics (WSL and registry) where small, self-contained pages in the reference section.
The explanation attempts to describe the individual components but also make connections between those components, so that the reader can better understand the software as a whole.
In 26c7c28 a glossary of system components is included as a separate reference page. This can be quickly scanned for information about the major components, providing basic descriptions and any relevant commands.
NOTE: these sections could be better linked with the rest of the documentation, but I want to wait until we merge the Ubuntu WSL documentation with this repo because that will involve some restructuring.
The following commits address comments raised by @CarlosNihelton in PR 981:
Other minor changes include:
UDENG-5517